Insert spaces around backticks for markups to be correctly detected by noritada · Pull Request #141 · progit/progit2-ja

noritada · 2022-01-22T09:45:23Z

Hi,

This is a series of corrections for issues that some markups are not detected in following sections:

book/02-git-basics/sections/recording-changes.asc HTML
book/09-git-and-other-scms/sections/import-svn.asc HTML
book/A-git-in-other-environments/sections/*.asc HTML
book/B-embedding-git/sections/jgit.asc HTML

Could you please review?

Many thanks

…in recording-changes.asc)

…ing-changes.asc) This commit incorporates markup changes in the original text.

…in A-git-in-other-environments)

This commit incorporates markup changes in the original text.

…in jgit.asc)

…in import-svn.asc)

tnir

Almost every reformatting looks good except that ``...'' should be preserved 👍

tnir · 2022-03-14T06:11:51Z

book/02-git-basics/sections/recording-changes.asc


 //////////////////////////
-The `CONTRIBUTING.md` file appears under a section named ``Changes not staged for commit'' – which means that a file that is tracked has been modified in the working directory but not yet staged.
+The `CONTRIBUTING.md` file appears under a section named "`Changes not staged for commit`" -- which means that a file that is tracked has been modified in the working directory but not yet staged.


I don't think we need this kind of change 🤔

Suggested change

The `CONTRIBUTING.md` file appears under a section named "`Changes not staged for commit`" -- which means that a file that is tracked has been modified in the working directory but not yet staged.

The `CONTRIBUTING.md` file appears under a section named ``Changes not staged for commit'' -- which means that a file that is tracked has been modified in the working directory but not yet staged.

tnir · 2022-03-14T06:12:05Z

book/02-git-basics/sections/recording-changes.asc

 To stage it, you run the `git add` command.
 `git add` is a multipurpose command – you use it to begin tracking new files, to stage files, and to do other things like marking merge-conflicted files as resolved.
-It may be helpful to think of it more as ``add this content to the next commit'' rather than ``add this file to the project''.(((git commands, add)))
+It may be helpful to think of it more as "`add this content to the next commit`" rather than "`add this file to the project`".(((git commands, add)))


Suggested change

It may be helpful to think of it more as "`add this content to the next commit`" rather than "`add this file to the project`".(((git commands, add)))

It may be helpful to think of it more as ``add this content to the next commit'' rather than ``add this file to the project''.(((git commands, add)))

tnir · 2022-03-14T06:13:09Z

book/02-git-basics/sections/recording-changes.asc

+`CONTRIBUTING.md` ファイルは "`Changed but not staged for commit`" という欄に表示されます。これは、追跡対象のファイルが作業ディレクトリ内で変更されたけれどもまだステージされていないという意味です。
+ステージするには `git add` コマンドを実行します。 `git add` にはいろんな意味合いがあり、新しいファイルの追跡開始・ファイルのステージング・マージ時に衝突が発生したファイルに対する「解決済み」マーク付けなどで使用します。 "`指定したファイルをプロジェクトに追加(add)する`" コマンド、というよりは、 "`指定した内容を次のコミットに追加(add)する`" コマンド、と捉えるほうがわかりやすいかもしれません。(((git commands, add)))


Suggested change

`CONTRIBUTING.md` ファイルは "`Changed but not staged for commit`" という欄に表示されます。これは、追跡対象のファイルが作業ディレクトリ内で変更されたけれどもまだステージされていないという意味です。

ステージするには `git add` コマンドを実行します。 `git add` にはいろんな意味合いがあり、新しいファイルの追跡開始・ファイルのステージング・マージ時に衝突が発生したファイルに対する「解決済み」マーク付けなどで使用します。 "`指定したファイルをプロジェクトに追加(add)する`" コマンド、というよりは、 "`指定した内容を次のコミットに追加(add)する`" コマンド、と捉えるほうがわかりやすいかもしれません。(((git commands, add)))

`CONTRIBUTING.md` ファイルは ``Changed but not staged for commit'' という欄に表示されます。これは、追跡対象のファイルが作業ディレクトリ内で変更されたけれどもまだステージされていないという意味です。

ステージするには `git add` コマンドを実行します。 `git add` にはいろんな意味合いがあり、新しいファイルの追跡開始・ファイルのステージング・マージ時に衝突が発生したファイルに対する「解決済み」マーク付けなどで使用します。 ``指定したファイルをプロジェクトに追加(add)する'' コマンド、というよりは、 ``指定した内容を次のコミットに追加(add)する'' コマンド、と捉えるほうがわかりやすいかもしれません。(((git commands, add)))

tnir · 2022-03-14T06:13:57Z

book/A-git-in-other-environments/sections/guis.asc


 //////////////////////////
-* On the left is the list of repositories the client is tracking; you can add a repository (either by cloning or attaching locally) by clicking the ``+'' icon at the top of this area.
+* On the left is the list of repositories the client is tracking; you can add a repository (either by cloning or attaching locally) by clicking the "`+`" icon at the top of this area.


Suggested change

* On the left is the list of repositories the client is tracking; you can add a repository (either by cloning or attaching locally) by clicking the "`+`" icon at the top of this area.

* On the left is the list of repositories the client is tracking; you can add a repository (either by cloning or attaching locally) by clicking the ``+'' icon at the top of this area.

tnir · 2022-03-14T06:14:14Z

book/A-git-in-other-environments/sections/guis.asc

 * The last thing to notice is the ``Sync'' button at the top-right, which is the primary way you interact over the network.
 //////////////////////////
-* 左側には、クライアントが追跡しているリポジトリのリストが表示されます。この領域の一番上の ``+ '' アイコンをクリックすると、（ローカルでクローンするかアタッチするかして）リポジトリを追加できます。
+* 左側には、クライアントが追跡しているリポジトリのリストが表示されます。この領域の一番上の "`+`" アイコンをクリックすると、（ローカルでクローンするかアタッチするかして）リポジトリを追加できます。


Suggested change

* 左側には、クライアントが追跡しているリポジトリのリストが表示されます。この領域の一番上の "`+`" アイコンをクリックすると、（ローカルでクローンするかアタッチするかして）リポジトリを追加できます。

* 左側には、クライアントが追跡しているリポジトリのリストが表示されます。この領域の一番上の ``+ '' アイコンをクリックすると、（ローカルでクローンするかアタッチするかして）リポジトリを追加できます。

noritada · 2022-03-25T08:44:16Z

@tnir Thank you very much for review comments and I'm sorry for my missing explanations.

I made this change because when multiple pairs of this markup are included, like ``foo'' and ``bar'', AsciiDoctor recognizes that foo'' and is the content of quotes of `` and wrongly highlights those words.
I investigated this issue and found that AsciiDoctor's curved quotation syntax seems to have been changed from ``foo'' to `"foo"` in v1.5.0, and this book's English version has already been changed to the new syntax. For this reason, I made corresponding changes in this PR to avoid highlighting issues.

However, I myself respect the original Japanese translation, so if there is any problem, I would like to revert to the original syntax. Could you give me a suggestion on which is better?

noritada added 6 commits January 22, 2022 18:36

Insert spaces around backticks for markups to be correctly detected (…

b97c2b2

…in recording-changes.asc)

Make quotations recognized correctly by correcting markups (in record…

e42a571

…ing-changes.asc) This commit incorporates markup changes in the original text.

Insert spaces around backticks for markups to be correctly detected (…

eeea256

…in A-git-in-other-environments)

Make quotations recognized correctly by correcting markups (in guis.asc)

a265cab

This commit incorporates markup changes in the original text.

Insert spaces around backticks for markups to be correctly detected (…

4c7f77c

…in jgit.asc)

Insert spaces around backticks for markups to be correctly detected (…

45f2b9d

…in import-svn.asc)

tnir requested changes Mar 14, 2022

View reviewed changes

tnir assigned noritada Mar 14, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Insert spaces around backticks for markups to be correctly detected#141

Insert spaces around backticks for markups to be correctly detected#141
noritada wants to merge 6 commits intoprogit:masterfrom
noritada:fix-backticks-and-quotations-3

noritada commented Jan 22, 2022

Uh oh!

tnir left a comment

Uh oh!

tnir Mar 14, 2022

Uh oh!

tnir Mar 14, 2022

Uh oh!

tnir Mar 14, 2022

Uh oh!

tnir Mar 14, 2022

Uh oh!

tnir Mar 14, 2022

Uh oh!

noritada commented Mar 25, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	The `CONTRIBUTING.md` file appears under a section named "`Changes not staged for commit`" -- which means that a file that is tracked has been modified in the working directory but not yet staged.
	The `CONTRIBUTING.md` file appears under a section named ``Changes not staged for commit'' -- which means that a file that is tracked has been modified in the working directory but not yet staged.

	It may be helpful to think of it more as "`add this content to the next commit`" rather than "`add this file to the project`".(((git commands, add)))
	It may be helpful to think of it more as ``add this content to the next commit'' rather than ``add this file to the project''.(((git commands, add)))

		`CONTRIBUTING.md` ファイルは "`Changed but not staged for commit`" という欄に表示されます。これは、追跡対象のファイルが作業ディレクトリ内で変更されたけれどもまだステージされていないという意味です。
		ステージするには `git add` コマンドを実行します。 `git add` にはいろんな意味合いがあり、新しいファイルの追跡開始・ファイルのステージング・マージ時に衝突が発生したファイルに対する「解決済み」マーク付けなどで使用します。 "`指定したファイルをプロジェクトに追加(add)する`" コマンド、というよりは、 "`指定した内容を次のコミットに追加(add)する`" コマンド、と捉えるほうがわかりやすいかもしれません。(((git commands, add)))

	* On the left is the list of repositories the client is tracking; you can add a repository (either by cloning or attaching locally) by clicking the "`+`" icon at the top of this area.
	* On the left is the list of repositories the client is tracking; you can add a repository (either by cloning or attaching locally) by clicking the ``+'' icon at the top of this area.

	* 左側には、クライアントが追跡しているリポジトリのリストが表示されます。この領域の一番上の "`+`" アイコンをクリックすると、（ローカルでクローンするかアタッチするかして）リポジトリを追加できます。
	* 左側には、クライアントが追跡しているリポジトリのリストが表示されます。この領域の一番上の ``+ '' アイコンをクリックすると、（ローカルでクローンするかアタッチするかして）リポジトリを追加できます。

Conversation

noritada commented Jan 22, 2022

Uh oh!

tnir left a comment

Choose a reason for hiding this comment

Uh oh!

tnir Mar 14, 2022

Choose a reason for hiding this comment

Uh oh!

tnir Mar 14, 2022

Choose a reason for hiding this comment

Uh oh!

tnir Mar 14, 2022

Choose a reason for hiding this comment

Uh oh!

tnir Mar 14, 2022

Choose a reason for hiding this comment

Uh oh!

tnir Mar 14, 2022

Choose a reason for hiding this comment

Uh oh!

noritada commented Mar 25, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants